eKOK Dokumentacja Integracyjna
0.4.0 - draft Poland flag

Profil zasobu: PLDocumentReference

Logiczny url: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference Wersja: 0.4.0
Active z dnia 2026-02-16 Nazwa: PLDocumentReference

Profil PLDocumentReference jest profilem referencji do Dokumentu na bazie zasobu FHIR DocumentReference, opracowanym na potrzeby obsługi Dokumentów Medycznych na serwerze FHIR CEZ.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Profil

Opis sposobu prezentacji profilu ujęty jest w specyfikacji standardu FHIR.

Struktura bazuje na DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta 1..1 Meta Metadane zasobu
.... profile 1..1 canonical(StructureDefinition) Profil zasobu
Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
... implicitRules 0..0
... language 0..0
... contained 0..0
... masterIdentifier 1..1 Identifier Identyfikator Dokumentu Medycznego
.... use 0..0
.... type 0..0
.... system 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
.... value 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
.... period 0..0
.... assigner 0..0
... identifier 0..0
... status 1..1 code Status referencji Dokumentu Medycznego
... docStatus 1..1 code Status Dokumentu Medycznego
... type 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
.... coding 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... system 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... version 0..0
..... code 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
..... userSelected 0..0
.... text 0..0
... category 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
.... coding 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... system 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... version 0..0
..... code 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
..... userSelected 0..0
.... text 0..0
... subject 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Identyfikator Pacjenta
..... system 1..1 uri OID systemu identyfikacji Pacjenta
..... value 1..1 string Identyfikator Pacjenta
.... display 0..0
... date 0..0
... author 0..0
... authenticator 0..0
... custodian 1..1 Reference(Organization) Repozytorium
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Identyfikator Repozytorium
..... use 0..0
..... type 0..0
..... system 0..0
..... value 1..1 string Identyfikator Repozytorium
..... period 0..0
..... assigner 0..0
.... display 0..0
... relatesTo 0..0
... description 0..0
... securityLabel 0..0
... content 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... code 1..1 code Kod kategorii kodu dostępnościa
.... attachment 1..1 Attachment Dokumentu Medyczny
..... contentType 1..1 code Format dokumentu
..... language 0..0
..... data 0..0
..... url 0..0
..... size 0..0
..... hash 0..0
..... title 0..0
..... creation 1..1 dateTime Data wystawienia dokumentu
.... format 0..0
... context 1..1 BackboneElement Kontekst kliniczny dokumentu
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... reference 0..0
..... type 0..0
..... identifier 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... use 0..0
...... type 0..0
...... system 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
...... value 1..1 string Identyfikator Zdarzenia Medycznego
...... period 0..0
...... assigner 0..0
..... display 0..0
.... event 0..0
.... period 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..0
.... related 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta Σ 1..1 Meta Metadane zasobu
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 1..1 Identifier Identyfikator Dokumentu Medycznego
.... system Σ 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
Example General: 123456
... docStatus Σ 1..1 code Status Dokumentu Medycznego
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... system Σ 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... category Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... system Σ 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... subject Σ 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... identifier Σ 1..1 Identifier Identyfikator Pacjenta
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri OID systemu identyfikacji Pacjenta
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identyfikator Pacjenta
Example General: 123456
... custodian 1..1 Reference(Organization) Repozytorium
.... identifier Σ 1..1 Identifier Identyfikator Repozytorium
..... value Σ 1..1 string Identyfikator Repozytorium
Example General: 123456
... content Σ 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... extension 0..0
...... url 1..1 uri "https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus"
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... code Σ 1..1 code Kod kategorii kodu dostępnościa
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Dokumentu Medyczny
..... contentType Σ 1..1 code Format dokumentu
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... creation Σ 1..1 dateTime Data wystawienia dokumentu
... context Σ 1..1 BackboneElement Kontekst kliniczny dokumentu
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... identifier Σ 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... system Σ 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string Identyfikator Zdarzenia Medycznego
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadane zasobu
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier Σ 1..1 Identifier Identyfikator Dokumentu Medycznego
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
Example General: 123456
... status ?!Σ 1..1 code Status referencji Dokumentu Medycznego
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 1..1 code Status Dokumentu Medycznego
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... category Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... subject Σ 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identyfikator Pacjenta
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri OID systemu identyfikacji Pacjenta
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identyfikator Pacjenta
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... custodian 1..1 Reference(Organization) Repozytorium
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identyfikator Repozytorium
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 1..1 string Identyfikator Repozytorium
Example General: 123456
... content Σ 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus"
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... code Σ 1..1 code Kod kategorii kodu dostępnościa
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Dokumentu Medyczny
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Format dokumentu
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... creation Σ 1..1 dateTime Data wystawienia dokumentu
... context Σ 1..1 BackboneElement Kontekst kliniczny dokumentu
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier Σ 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string Identyfikator Zdarzenia Medycznego
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Struktura bazuje na DocumentReference

Summary

Mandatory: 32 elements
Fixed: 1 element
Prohibited: 52 elements

Extensions

This structure refers to these extensions:

Widok Differential

Struktura bazuje na DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta 1..1 Meta Metadane zasobu
.... profile 1..1 canonical(StructureDefinition) Profil zasobu
Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
... implicitRules 0..0
... language 0..0
... contained 0..0
... masterIdentifier 1..1 Identifier Identyfikator Dokumentu Medycznego
.... use 0..0
.... type 0..0
.... system 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
.... value 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
.... period 0..0
.... assigner 0..0
... identifier 0..0
... status 1..1 code Status referencji Dokumentu Medycznego
... docStatus 1..1 code Status Dokumentu Medycznego
... type 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
.... coding 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... system 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... version 0..0
..... code 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
..... userSelected 0..0
.... text 0..0
... category 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
.... coding 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... system 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... version 0..0
..... code 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
..... userSelected 0..0
.... text 0..0
... subject 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Identyfikator Pacjenta
..... system 1..1 uri OID systemu identyfikacji Pacjenta
..... value 1..1 string Identyfikator Pacjenta
.... display 0..0
... date 0..0
... author 0..0
... authenticator 0..0
... custodian 1..1 Reference(Organization) Repozytorium
.... reference 0..0
.... type 0..0
.... identifier 1..1 Identifier Identyfikator Repozytorium
..... use 0..0
..... type 0..0
..... system 0..0
..... value 1..1 string Identyfikator Repozytorium
..... period 0..0
..... assigner 0..0
.... display 0..0
... relatesTo 0..0
... description 0..0
... securityLabel 0..0
... content 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... code 1..1 code Kod kategorii kodu dostępnościa
.... attachment 1..1 Attachment Dokumentu Medyczny
..... contentType 1..1 code Format dokumentu
..... language 0..0
..... data 0..0
..... url 0..0
..... size 0..0
..... hash 0..0
..... title 0..0
..... creation 1..1 dateTime Data wystawienia dokumentu
.... format 0..0
... context 1..1 BackboneElement Kontekst kliniczny dokumentu
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... reference 0..0
..... type 0..0
..... identifier 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... use 0..0
...... type 0..0
...... system 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
...... value 1..1 string Identyfikator Zdarzenia Medycznego
...... period 0..0
...... assigner 0..0
..... display 0..0
.... event 0..0
.... period 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..0
.... related 0..0

doco Documentation for this format

Widok kluczowych elementów

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta Σ 1..1 Meta Metadane zasobu
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 1..1 Identifier Identyfikator Dokumentu Medycznego
.... system Σ 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
Example General: 123456
... docStatus Σ 1..1 code Status Dokumentu Medycznego
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... system Σ 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... category Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... system Σ 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... subject Σ 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... identifier Σ 1..1 Identifier Identyfikator Pacjenta
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri OID systemu identyfikacji Pacjenta
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identyfikator Pacjenta
Example General: 123456
... custodian 1..1 Reference(Organization) Repozytorium
.... identifier Σ 1..1 Identifier Identyfikator Repozytorium
..... value Σ 1..1 string Identyfikator Repozytorium
Example General: 123456
... content Σ 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... extension 0..0
...... url 1..1 uri "https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus"
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... code Σ 1..1 code Kod kategorii kodu dostępnościa
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Dokumentu Medyczny
..... contentType Σ 1..1 code Format dokumentu
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... creation Σ 1..1 dateTime Data wystawienia dokumentu
... context Σ 1..1 BackboneElement Kontekst kliniczny dokumentu
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... identifier Σ 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... system Σ 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string Identyfikator Zdarzenia Medycznego
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Widok Snapshot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadane zasobu
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentReference
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... extension 0..* Extension Additional content defined by implementations
... masterIdentifier Σ 1..1 Identifier Identyfikator Dokumentu Medycznego
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri OID systemu identyfikacji Dokumentu Medycznego
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Identyfikator Dokumentu Medycznego w systemie identyfikacji
Example General: 123456
... status ?!Σ 1..1 code Status referencji Dokumentu Medycznego
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 1..1 code Status Dokumentu Medycznego
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji LOINC
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania LOINC
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri OID systemu kodowania LOINC typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania LOINC
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... category Σ 1..1 CodeableConcept Typ Dokumentu Medycznego wg klasyfikacji P1
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Typ Dokumentu Medycznego w systemie kodowania P1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri OID systemu kodowania P1 typów Dokumentów Medycznych
..... code Σ 1..1 code Kod typu Dokumentu Medycznego w systemie kodowania P1
..... display Σ 1..1 string Opis typu Dokumentu Medycznego odpowiadający wartości kodu
... subject Σ 1..1 Reference(Patient | Practitioner | Group | Device) Identyfikator Pacjenta
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identyfikator Pacjenta
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri OID systemu identyfikacji Pacjenta
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string Identyfikator Pacjenta
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... custodian 1..1 Reference(Organization) Repozytorium
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identyfikator Repozytorium
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ 1..1 string Identyfikator Repozytorium
Example General: 123456
... content Σ 1..1 BackboneElement Dane dotyczące treści Dokumentu Medycznego
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:PLDocumentAvailabilityStatus 1..* (Complex) Status dostępności Dokumentu Medycznego
URL: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://ezdrowie.gov.pl/fhir/StructureDefinition/PLDocumentAvailabilityStatus"
...... value[x] 1..1 Coding Kategoria kodu dostępności w systemie kodowania
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... code Σ 1..1 code Kod kategorii kodu dostępnościa
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Dokumentu Medyczny
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 1..1 code Format dokumentu
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... creation Σ 1..1 dateTime Data wystawienia dokumentu
... context Σ 1..1 BackboneElement Kontekst kliniczny dokumentu
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 1..1 Reference(Encounter | EpisodeOfCare) Zdarzenie Medyczne
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier Σ 1..1 Identifier Identyfikator Zdarzenia Medycznego
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri OID systemu identyfikacji Zdarzeń Medycznych
Example General: http://www.acme.com/identifiers/patient
...... value Σ 1..1 string Identyfikator Zdarzenia Medycznego
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.subject.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Struktura bazuje na DocumentReference

Summary

Mandatory: 32 elements
Fixed: 1 element
Prohibited: 52 elements

Extensions

This structure refers to these extensions:

 

Inne struktury profilu: CSV, Excel, Schematron